What’s New in the CygNet v9.7 Help
The v9.7 Online Help includes many documentation updates to describe the new features and enhancements contained in the CygNet Software v9.7 release.
Notes:
- See the
CygNet v9.7 Release Notes for a more complete list of enhancements and modifications made to CygNet SCADA and CygNet Measurement.
- Some functionality has been patched since CygNet Software, Inc. v9.7 was released. Check for any available v9.7 patches on the CygNet Software Downloads site. If any CygNet help topic or section has been updated to reflect new functionality, it is noted below.
Changes to the v9.7 Online Help
The following documentation items have been added, removed, or revised in the CygNet Software v9.7 Online Help. Changes are listed in order of the Online Help document sections in which they appear.
Alarms
- The CygNet Alarm Manager now supports multiple filter rules in a single filter file. See Filtering CygNet Alarm Manager Operations for more information.
- Clarified documentation for the Deviation For Time alarm calculation types. (updated August 16, 2024)
Auditing
- Added a new topic on Suppressing SetPoint Auditing Based User ID.
Canvas
- Several changes have been made to support Canvas in v9.7. See the What's New in the v9.7 Canvas Help section in the CygNet Canvas chapter for more information.
CygNet HMI Clients
- The table of contents for the CygNet Software Online Help has been reorganized to group the human machine interface (HMI) clients under a single node: CygNet HMI Clients. The four clients are:
- CygNet Studio is CygNet's original HMI client application for creating operational screens to control and monitor devices, display data, alarms, and trends. Studio is a desktop HMI application, part of the suite of CygNet components. See CygNet Studio for more information.
- CygNet Vision is the runtime companion application to CygNet Studio.
- Canvas is CygNet's primary desktop HMI application, providing high-quality screen design functionality and viewing, utilizing a variety of specialized tools and controls, which you can use to create user screens to interface with CygNet services and data. You can also view CygNet Studio screens in Canvas.. See CygNet Canvas for more information.
- CygNet Thin Web Client (TWC) is CygNet's browser-based HMI client application for viewing operational screens and workflows in a Web browser using sophisticated web-based technologies. Currently the designer for building web-based screens is a web-enhanced version of the Canvas desktop application. See CygNet Thin Web Client for more information.
- CygNet Operator for CygNet Mobile is a mobile app for viewing critical CygNet SCADA data on an Apple iOS or Android mobile device. It is the HMI component of the CygNet Mobile Application Suite. You can use the CygNet Operator to view a set of fixed screens including: a map of relevant equipment and facilities, current data, trend historical data, and view and acknowledge both CAS alarms and GNS notifications in a single operation. See CygNet Operator for more information.
CygNet Studio
- CAS View Control — Added details on how to hide default menu items from display
- Configuring Context Menus and Custom Context Menu — Updated images and related text
- Dynagraph Control — Added new ActiveX properties to configure the background color of the Dynagraph object (BackColor) and the Dynagraph graph area (GraphBackgroundColor).
CygNet Measurement
- CygNet Measurement Overview — updated diagram and liquid support table to reflect new functionality
- Installing CygNet Measurement and Configuring Email Options — added procedural steps and configuration file fields in support of new OAuth 2 email handling option
- Import: Alarms CSV and Configuring Import: Alarms CSV Commands — added topics describing the new Import: Alarms CSV command, and edited associated topics
- Import: Events CSV and Configuring Import: Events CSV Commands — added topics describing the new Import: Events CSV command, and edited associated topics
- FMS Data Items Units — added support for additional volume and flow rate units, including E3m3 and E6m3 (for Uncorrected volume, Volume, GSV, GV, IV, NSV, Odorized volume, and S&W volume, where appropriate), and E3m3/D and E6m3/D (for Flow rate, and Low flow cutoff - volume flow rate, where appropriate)
- Collection Details in the CygNet Measurement Concepts topic — added collection detail values for Batch (B) and Ticket (T) data types, which can now be seen in the "Collection details" data view of the Dashboard control, when viewing the status of missing history data for liquid device Nodes
- Using the Balance Control and CygNet FMS Balance Control — described the new Balance control option to initially show only monthly or daily records, and only show hourly records upon request, plus added properties and edited content in associated topics
- CxFmsBalanceCtrl - Events — added a new Balance control event EventGridFinished to support grid color and performance enhancements
- Using the Configuration Control and CygNet FMS Configuration Control — described the new Configuration control support for viewing, creating, and editing liquid configuration data
- Using the History Grid Control and CygNet FMS History Grid Control — described the new History Grid control option to highlight data causing exceptions, plus added properties and edited content in associated topics
- Using the History Grid Control — described the new History Grid control ability to multi-select and ignore, in a single action, several records generating exceptions
- FMS Validation Rules — removed the "Time Synchronization" rule type and its "Device Rule" category from listed Validation engine options, plus references to it
- Using the History Graph Control and CygNet FMS History Graph Control — updated text descriptions to clarify that the "Native" record span option appears only in the Device data view and is not applicable to the Station data view, as well as property descriptions in associated topics
- Using the History Grid Control and CygNet FMS History Grid Control — updated text descriptions to clarify that the "Native" record span option appears only in the Device data view and is not applicable to the Station data view, as well as property descriptions in associated topics
- CxHmiFms — streamlined scripting value tables and property options for consistency in the Node Chooser, Balance, Close Period, Exceptions, Jobs, and Report control topics
- Supported Tokens for Device Data CSV Exports — clarified the usage of tokens appended with _Begin or _End values
- Device Total QTR Report Templates reports — clarified the usage of tokens appended with _Begin or _End values
- Using the Internal Database, Installing CygNet Measurement, and CygNet Measurement Software Components — changed text related to SQL server installations to clarify the 1:1 relationship between an FMS Service and SQL server, and to list the number of supported FMS Nodes per SQL server (updated July 31, 2023).
CygNet Release Documents — Added language to the following documents to clarify the relationship between Microsoft SQL Server and the FMS Service for CygNet Measurement (updated November 15, 2024):
CygNet Thin Web Client
- Updated the CygNet online help to document changes to the CygNet Thin Web Client v1.6, released November 15, 2024
- Updated the CygNet online help to document changes to the CygNet Thin Web Client v1.4, released April 12, 2024
- Updated the CygNet online help to document changes to the CygNet Thin Web Client v1.2, released December 15, 2023
- Updated the CygNet online help to document the CygNet Thin Web Client v1.0, released July 31, 2023.
Device Definition Service (DDS) — Documented a new service configuration keyword, SUPPRESS_SCRUBBER_REPL. (updated August 3, 2023)
Devices — Import Export Devices
-
SonicMQ Export EIE — The following updates have been documented:
-
The Export Destination page of the device editor has been modified to allow configuration of the following new options:
- The three export Folder Paths now support system environment variable tokens in the format: “%MY_SPECIAL_ENV_VAR%\Listener”
- Retry Folder Path
- Retry Max Files
- A file export retry feature has been added when exporting to a file system.
-
Devices — Remote Devices
- Data Groups topics — added usage notes:
- Point Processing on History data groups (updated December 15, 2023)
- UDC and Point Processing on FMS data groups (updated December 15, 2023)
- UIS Commands — Added some links about using and scripting UIS Commands. Added ConvertBCD keyword to cvtF Conversion Methods
- DNP3 EIE — Changed Listen Mode to Yes (updated April 10, 2025)
- Emerson ROC EIE
- Added support for an updated Emerson firmware for the FloBoss 107 devices, which complies with enhanced security features stipulated by the United States Transport Security Administration (TSA) Security Directive Pipeline-2021-02. (updated in Patch-2023-10-17-EmersonRoc, released November 30, 2023.)
Added features include:- Modifications to the Device page of the Emerson ROC EIE device editor to support the configuration of the secure login credentials. The new Login secure field on the Device page will display only for the ROC 107 devices that support the new firmware.
- An enhanced security data group, LoginSec ("Login Secure Enhanced Request"), using the Emerson Opcode 17. The EmersonRoc_107.dtf has been modified to include the new LoginSec data group.
- A new UIS command "component type" LOGINSEC (Login Secure), to send enhanced security credentials to the device. The UIS command uses the login credential information from the Login secure section of the Device page on the remote device editor.
- Added a note to FMS History Data Group Mapping indicating that the Emerson FloBoss 107 device uses Opcode 136 (History Multiple Points Periodic) for polling FMS Daily History and FMS Hourly History data. Opcode 136 is only available on the FloBoss 107, ROC800, and ROC800L devices. (Related to Patch-2023-11-01-UisEmersonRocDriver, released November 30, 2023.)
- Added support for an updated Emerson firmware for the FloBoss 107 devices, which complies with enhanced security features stipulated by the United States Transport Security Administration (TSA) Security Directive Pipeline-2021-02. (updated in Patch-2023-10-17-EmersonRoc, released November 30, 2023.)
- Emerson ROCPlus EIE
- Added support for an updated Emerson firmware for the ROC800 and ROC800L devices, which complies with enhanced security features stipulated by the United States Transport Security Administration (TSA) Security Directive Pipeline-2021-02. (ppdated in Patch-2023-10-11-EmersonRocPlus, released November 30, 2023.)
Added features include:- Modifications to the Device page of the Emerson ROC EIE device editor to support the configuration of the secure login credentials. The new Login secure field on the Device page will display only for the ROC800 and ROC800L devices that support the new firmware.
- An enhanced security data group, LoginSec ("Login Secure Enhanced Request"), using the Emerson Opcode 17. The EmersonRocPlus_800.dtf and EmersonRocPlus_800L.dtf have been modified to include the new LoginSec data group.
- A new UIS command "component type" LOGINSEC (Login Secure), to send enhanced security credentials to the device. The UIS command uses the login credential information from the Login secure section of the Device page on the remote device editor.
- Added a Logout ("Logout Request") data group for ROC800 and ROC800L devices. The logout request is issued to the device via Opcode 17.
- Added support for an updated Emerson firmware for the ROC800 and ROC800L devices, which complies with enhanced security features stipulated by the United States Transport Security Administration (TSA) Security Directive Pipeline-2021-02. (ppdated in Patch-2023-10-11-EmersonRocPlus, released November 30, 2023.)
- OPC EIE — the following updates have been made to this EIE:
- Added a new topic Using Sentinel Values to Indicate Unreliable Data about configuring point processing to handle unreliable values returned from an OPC server
- Supplemented OPC Quality Mapping topic with new information about updating values for mapped quality bits
- Updated OPC EIE Editor - Device Page with Sentinel Value options
- Updated OPC EIE - Data Groups with Sentinel Value options.
- OPC Lufkin EIE — the following updates have been made to this EIE:
- Updated OPC Lufkin EIE Editor - Device Page with Sentinel Value options
- Added OPC Lufkin EIE - Data Groups, linked to OPC EIE - Data Groups (for shared information for all OPC EIEs).
- OPC Weatherford EIE — the following updates have been made to this EIE:
- Indicated support for OPC Baker 8300/8500 protocol devices on the Matrikon ScadaCAC OPC server and OPCWFord_8500.dtf to support Matrikon OPC card retrieval from Baker 8300/8500 protocol devices
- Indicated support for version 2 of legacy (FC16) dynagraph card format used by ScadaCAC to get data from Baker 8500 devices. Previously only version 3 was supported
- Updated OPC Weatherford EIE Editor - Device Page with Sentinel Value options
- Added OPC Weatherford EIE - Data Groups
- linked to OPC EIE - Data Groups (for shared information for all OPC EIEs)
- added table of supported data groups
- indicated that the OPC Weatherford EIE now supports composite data groups
- the DynaConfig “Pumpoff Configuration” data group is required to render the POC stroke percentage.
- Totalflow EIE — added K Factor Mass to FMS Configuration Data Group Mapping topic.
Glossary of Terms
-
Updated information in the Glossary of Terms and related topics about naming standards and character limits for the following entities (updated November 15, 2024):
| Glossary Entry | Related Topic |
|---|---|
| Device ID | many |
| Facility ID | Facility Identifier |
| Long Point ID | Point Identifiers |
| Point ID | Point Identifiers |
| Service | Installing and Deleting Services |
| Site | Services Overview |
| UDC | Naming UDCs |
History — Simplified information about the VHS legacy datastore, which was end-of-lifed in CygNet v8.1.3.
ODBC — Updated installation information and CygNet location information for DataDirect OpenAccess Management Console in Configuring Advanced Options.
OPC
- Added information about using sentinel values in the OPC EIEs in the OPCIS vs OPC EIEs topic
- Added a note about the most efficient way to register tags with the CygNet OPC Server and the CygNet OPC HDA Server
- Better described how the Table Driven 1 data field is used to indicate what to do with the value of an OPC tag with OPC Quality flags that indicate an error on the OPC Groups topic.
Legal Notices — Added the SkiaSharp license. The SkiaSharp API library supports platform-independent color transformations in .NET projects to convert point state colors for use in CygNet's Thin Web client screens.
Points
- Added new Volume and Flow Volume PNT Engineering Units:
- Documented unit aliases for PNT Engineering Units
- Clarified the description for Manual update mode on the General page of the PNT Editor and other related topics
- Improved the descriptions for the General 1, General 2, General 3, Table Driven 1, Table Driven 2, and Table Driven 3 data fields on the Application page of the PNT Editor and other related topics.
- Clarified TagFormat values in CxPnt.CxPntClient.GetPointTagList method. (updated November 15, 2024)
Scheduler — Updated MSS Scripting topic to include references to CygNet.Schedules.API. (updated August 3, 2023)
Scripting — The following updates have been documented:
- Updated CygNet .NET API to reflect new CygNet v9.7 APIs
- CxCvs
- CvsClient Methods — Updated formatting on other methods
- CxCvsLib Helper Objects — Updated formatting on other objects
- CxDds.DdsClient — Documented new methods to support adding, deleting, and modifying a data group transaction through the COMAPI interface . Identified multithreaded calls. Reformatted code examples
- CxEditors.CxAudEditor Object — Removed the Delete method from the CxAudEditor API. Deleting audit records is not supported. (updated June 6, 2025)
- CxEditors.CxCvsEditor Object — Now documented
- CxFac.FacClient Methods — Identified multithreaded calls, reformatted code examples
- CxPnt.PntClient Methods — Identified multithreaded calls, reformatted code examples
- CxScript.FileSystemObject — Added two functions to the CxScript.FileSystemObject interface, CanReadBlobFile and GetBlobFileSecurityChain, to query the Blob file level security and the Blob folder level security settings fields from a BSS for a given file.
- CxUis.UisClient Methods
- Identified multithreaded calls, reformatted code examples
- Added a note to CxUis.UisClient.SendSingleUDC to describe a suggested solution to a use case when a Facility ID linked to a data group and the UDC point mapped to a data element in the same data group are different.
- CxVhs
- VhsClient Methods — Added new AddHistoryPointEx method to support assigning a Long PointId value when adding points to a VHS, updated formatting on other methods
- VhsDataStoreInterface Methods — Added new AddHistoryPointEx method to support assigning a Long PointId value when adding points to a VHS offline datastore, updated formatting on other methods
- VhsDataStoreInterface Methods — Modified the MaxDatastoreSizeMB parameter description in the Open method to clarify the default and maximum sizes for a VHS datastore
- VhsClient Iterator Objects — Updated formatting on Iterator methods
- VhsClient Helper Objects — Added supporting AddHistoryPointExReq and AddHistoryPointExResp objects, updated formatting on other objects
- Code samples have been reformatted so that you can copy directly from the online help and paste the code into a third-party editor.
Security — The following security events are now documented:
- RFACDEFS — required when using
CygNet.API.Facilities.Relative.RelativeFacilityDefinitionSetsto update the Relative Facility Definitions Sets file in the ARS directory - SUPSPAUD — used to support the suppression of SetPoint audit records in the UIS service database based on user ID.
Service Monitoring Info Items — The following info items are now documented:
- DDS_NO_SCRUB_REPL — Indicates whether the replication of DDS Transaction deletes is suppressed or not. (updated August 3, 2023)
- MACH_COMMIT_FREE — The maximum number of bytes that can still be committed without growing the page file. (Analogous to Free RAM.)
- MACH_COMMIT_PEAK — The maximum number of bytes that have ever been committed.
- MACH_COMMIT_TOTAL — The maximum number of bytes that can be committed without growing the page file. (Analogous to Total RAM.)
- SETPOINT_USERSEC_ENABLED — Indicates whether setpoint audit record creation in the AUD service database is suppressed based on user ID. Options are 0 (false) and 1 (true). Specifies the value of the AUDIT_SETPOINT_USERSEC_ENABLED service configuration keyword. See Suppressing SetPoint Auditing Based on User ID for more information about this feature.
- Added values for the Service Status (SVMSVST) ServiceMon UDC.
Services
- Added a new Auditing keyword to the CVS Configuration File Keywords topics to support the suppression of SetPoint audit records in the AUD service database based on user ID:
- AUDIT_SETPOINT_USERSEC_ENABLED in the Hss.cfg
- AUDIT_SETPOINT_USERSEC_ENABLED in the Opcis.cfg
- AUDIT_SETPOINT_USERSEC_ENABLED in the SvcMon.cfg
- AUDIT_SETPOINT_USERSEC_ENABLED in the Uis.cfg.
UIS
- Added note to UIS System UDCs about 20-minute statistics. (updated November 15, 2024)
Well Test
- Test performance and action execution have been significantly improved in the CygNet Well Test module (updated June 6, 2025).
- See the CygNet v9.9 Release Notes for a complete list of Well Test changes. Several topics have been updated to record new functionality (updated June 6, 2025).
- Updated Headers configuration topics and images with new UDCs: ContinuousMode, PendingWellQueue, and ActiveWellContinuousMode (updated June 6, 2025).
- Clarified Idle status for Abort and Complete header commands for the Pending Well Queue (updated June 6, 2025).
- Updated the description for the Exit command check box on an Exit action (updated June 6, 2025).
CygNet Web
- CygNet Web is validated to work with the Microsoft Edge browser with Internet Explorer (IE) mode
- Notice of Status Change (NSC) — The CygNet Web application is now in Limited Support with the release of CygNet v9.7, and will reach its End of Life with the release of v9.8. See the Product Lifecycle information in theCygNet v9.7 Release Notes.
Other Updates
